Create Data Dictionary

The essential steps to create a data dictionary are:

Object Selection

In the list, choose objects to include in the data dictionary.

Navicat Data Modeler will generate the data dictionary contents based on the sequence of the objects on the list. You can select the objects and use the arrow buttons to change the order.

Theme

Navicat Data Modeler provides several templates for data dictionary files. You can choose the appropriate template and follow the remaining steps to customize your settings.

Layout Settings

You can adjust the layout of the template and view the preview on the left pane.

Option

Description

Cover

Include cover

Add a cover page.

Header Logo

Insert a preceding image in the header.

Header

Enter a header that appears once at the top of the cover page.

Title

Enter the title of the data dictionary.

Subtitle

Enter the subtitle of the data dictionary.

Remarks

Enter remarks that appear on the cover page.

Background Image

Default - Use the default background image.
Custom - Insert a background image for the cover page.
None - Explicitly not insert a background image.

Footer

Enter a footer that appears once at the bottom of the cover page.

Table of Contents

Include table of contents

Add table of contents to the data dictionary.

Header/Footer

Include breadcrumbs header

Add a breadcrumbs header that appears at the top of every page except the cover and table of contents.

Heading Font

Set the font style of the heading.

Subheading Font

Set the font style of the subheading.

Include left footer

Add a footer that appears at the bottom left of every page except the cover, table of contents and introduction.

Include page number in right footer

Add page numbers to the right footer of every page except the cover, table of contents and introduction.

Footer Font

Set the font style of the footer.

Main Content

Include Introduction

Add a page for introducing the data dictionary.

Introduction

Enter the introduction.

Font

Set the font style of the introduction.

Paper

Paper

Choose the paper size.

Orientation

Select a page orientation (Portrait or Landscape).

Margin (CM)

Set the margins of the document.

File Path

In this tab, set the export file path and other advanced options.

Option

Description

Export To File

Specify the path of the data dictionary file.

Append timestamp to file name

Append timestamp information to the file name to show when the file is created.

Overwrite existing file

Overwrite if the file already exists.

Continue on error

Ignore errors that are encountered during the generation process.

Message Log

After clicking the Generate button, the Message Log tab will appear. It displays the success or failure messages and the file path information. Click the Open button to open the data dictionary file.